Resource URL: /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>

    Overview: This resource exposes a single OneFS network pool.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: View a single network pool.

       URL: GET
            /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "pools": {
      "items": {
        "type": "object", 
        "properties": {
          "ifaces": {
            "items": {
              "type": "object", 
              "properties": {
                "iface": {
                  "type": "string", 
                  "description": "A string that defines an interface name."
                }, 
                "lnn": {
                  "type": "integer", 
                  "description": "Logical Node Number."
                }
              }
            }, 
            "required": true, 
            "type": "array", 
            "description": "List of interface members in this pool."
          }, 
          "aggregation_mode": {
            "enum": [
              "roundrobin", 
              "failover", 
              "lacp", 
              "fec"
            ], 
            "type": "string", 
            "description": "OneFS supports the following NIC aggregation modes.", 
            "required": true
          }, 
          "sc_failover_policy": {
            "enum": [
              "round_robin", 
              "conn_count", 
              "throughput", 
              "cpu_usage"
            ], 
            "type": "string", 
            "description": "SmartConnect IP failover policy.", 
            "required": true
          }, 
          "sc_subnet": {
            "required": true, 
            "type": "string", 
            "description": "Name of SmartConnect service subnet for this pool."
          }, 
          "sc_suspended_nodes": {
            "items": {
              "type": "integer"
            }, 
            "required": true, 
            "type": "array", 
            "description": "List of LNNs showing currently suspended nodes in SmartConnect."
          }, 
          "id": {
            "required": true, 
            "type": "string", 
            "description": "Unique Pool ID."
          }, 
          "subnet": {
            "required": true, 
            "type": "string", 
            "description": "The name of the subnet."
          }, 
          "rebalance_policy": {
            "enum": [
              "auto", 
              "manual"
            ], 
            "type": "string", 
            "description": "Rebalance policy..", 
            "required": true
          }, 
          "sc_connect_policy": {
            "enum": [
              "round_robin", 
              "conn_count", 
              "throughput", 
              "cpu_usage"
            ], 
            "type": "string", 
            "description": "SmartConnect client connection balancing policy.", 
            "required": true
          }, 
          "groupnet": {
            "required": true, 
            "type": "string", 
            "description": "Name of the groupnet this pool belongs to."
          }, 
          "description": {
            "required": true, 
            "type": "string", 
            "description": "A description of the pool.", 
            "maxLength": 128
          }, 
          "rules": {
            "items": {
              "type": "string"
            }, 
            "required": true, 
            "type": "array", 
            "description": "Names of the rules in this pool."
          }, 
          "access_zone": {
            "minLength": 1, 
            "required": true, 
            "type": "string", 
            "description": "Name of a valid access zone to map IP address pool to the zone."
          }, 
          "alloc_method": {
            "enum": [
              "dynamic", 
              "static"
            ], 
            "type": "string", 
            "description": "Specifies how IP address allocation is done among pool members.", 
            "required": true
          }, 
          "ranges": {
            "items": {
              "type": "object", 
              "properties": {
                "high": {
                  "required": true, 
                  "type": "string", 
                  "description": "High IP"
                }, 
                "low": {
                  "required": true, 
                  "type": "string", 
                  "description": "Low IP"
                }
              }
            }, 
            "required": true, 
            "type": "array", 
            "description": "List of IP address ranges in this pool."
          }, 
          "sc_dns_zone_aliases": {
            "items": {
              "type": "string"
            }, 
            "required": true, 
            "type": "array", 
            "description": "List of SmartConnect zone aliases (DNS names) to the pool."
          }, 
          "sc_dns_zone": {
            "required": true, 
            "type": "string", 
            "description": "SmartConnect zone name for the pool."
          }, 
          "name": {
            "required": true, 
            "type": "string", 
            "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", 
            "maxLength": 32
          }, 
          "static_routes": {
            "items": {
              "type": "object", 
              "properties": {
                "prefixlen": {
                  "required": true, 
                  "type": "integer", 
                  "description": "Prefix length in the format: nn."
                }, 
                "subnet": {
                  "required": true, 
                  "type": "string", 
                  "description": "Network address in the format: xxx.xxx.xxx.xxx"
                }, 
                "gateway": {
                  "required": true, 
                  "type": "string", 
                  "description": "Address of the gateway in the format: yyy.yyy.yyy.yyy"
                }
              }
            }, 
            "required": true, 
            "type": "array", 
            "description": "List of interface members in this pool."
          }, 
          "sc_ttl": {
            "required": true, 
            "minimum": 0, 
            "type": "integer", 
            "description": "Time to live value for SmartConnect DNS query responses in seconds.", 
            "maximum": 2147483647
          }, 
          "addr_family": {
            "enum": [
              "ipv4", 
              "ipv6"
            ], 
            "type": "string", 
            "description": "IP address format.", 
            "required": true
          }, 
          "sc_auto_unsuspend_delay": {
            "required": true, 
            "minimum": 0, 
            "type": "integer", 
            "description": "Time delay in seconds before a node which has been                 automatically unsuspended becomes usable in SmartConnect                responses for pool zones.", 
            "maximum": 86400
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method PUT: Modify a network pool.

       URL: PUT
            /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>

Query arguments:
force=<boolean> force creating this pool even if it causes an MTU conflict.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "ranges": {
      "items": {
        "type": "object", 
        "properties": {
          "high": {
            "required": true, 
            "type": "string", 
            "description": "High IP"
          }, 
          "low": {
            "required": true, 
            "type": "string", 
            "description": "Low IP"
          }
        }
      }, 
      "type": "array", 
      "description": "List of IP address ranges in this pool."
    }, 
    "sc_ttl": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Time to live value for SmartConnect DNS query responses in seconds.", 
          "maximum": 2147483647
        }
      ]
    }, 
    "name": {
      "type": "string", 
      "description": "The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.", 
      "maxLength": 32
    }, 
    "static_routes": {
      "items": {
        "type": "object", 
        "properties": {
          "prefixlen": {
            "required": true, 
            "type": "integer", 
            "description": "Prefix length in the format: nn."
          }, 
          "subnet": {
            "required": true, 
            "type": "string", 
            "description": "Network address in the format: xxx.xxx.xxx.xxx"
          }, 
          "gateway": {
            "required": true, 
            "type": "string", 
            "description": "Address of the gateway in the format: yyy.yyy.yyy.yyy"
          }
        }
      }, 
      "type": "array", 
      "description": "List of interface members in this pool."
    }, 
    "ifaces": {
      "items": {
        "type": "object", 
        "properties": {
          "iface": {
            "type": "string", 
            "description": "A string that defines an interface name."
          }, 
          "lnn": {
            "type": "integer", 
            "description": "Logical Node Number."
          }
        }
      }, 
      "type": "array", 
      "description": "List of interface members in this pool."
    }, 
    "sc_auto_unsuspend_delay": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Time delay in seconds before a node which has been                 automatically unsuspended becomes usable in SmartConnect                responses for pool zones.", 
          "maximum": 86400
        }
      ]
    }, 
    "sc_subnet": {
      "type": "string", 
      "description": "Name of SmartConnect service subnet for this pool."
    }, 
    "access_zone": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minLength": 1, 
          "type": "string", 
          "description": "Name of a valid access zone to map IP address pool to the zone."
        }
      ]
    }, 
    "alloc_method": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "dynamic", 
            "static"
          ], 
          "type": "string", 
          "description": "Specifies how IP address allocation is done among pool members."
        }
      ]
    }, 
    "rebalance_policy": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "auto", 
            "manual"
          ], 
          "type": "string", 
          "description": "Rebalance policy.."
        }
      ]
    }, 
    "sc_dns_zone": {
      "type": "string", 
      "description": "SmartConnect zone name for the pool."
    }, 
    "aggregation_mode": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "roundrobin", 
            "failover", 
            "lacp", 
            "fec"
          ], 
          "type": "string", 
          "description": "OneFS supports the following NIC aggregation modes."
        }
      ]
    }, 
    "sc_failover_policy": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "round_robin", 
            "conn_count", 
            "throughput", 
            "cpu_usage"
          ], 
          "type": "string", 
          "description": "SmartConnect IP failover policy."
        }
      ]
    }, 
    "sc_connect_policy": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "round_robin", 
            "conn_count", 
            "throughput", 
            "cpu_usage"
          ], 
          "type": "string", 
          "description": "SmartConnect client connection balancing policy."
        }
      ]
    }, 
    "sc_dns_zone_aliases": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "List of SmartConnect zone aliases (DNS names) to the pool."
    }, 
    "description": {
      "type": "string", 
      "description": "A description of the pool.", 
      "maxLength": 128
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete a network pool.

          URL: DELETE
               /platform/<<version=3>>/network/groupnets/<GROUPNET>/subnets/<SUBNET>/pools/<POOL>

There are no query arguments for this method.

There is no response body for this method.
